<!DOCTYPE html>
<html lang="en">
  <head>
    <title>SwiftInstagram  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset="utf-8">
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
    <script src="js/lunr.min.js" defer></script>
    <script src="js/typeahead.jquery.js" defer></script>
    <script src="js/jazzy.search.js" defer></script>
  </head>
  <body>


    <a title="SwiftInstagram  Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="index.html">
          SwiftInstagram Docs
        </a>
         (100% documented)
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/AnderGoig/SwiftInstagram">
            <img class="header-icon" src="img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="index.html">SwiftInstagram Reference</a>
      <img class="carat" src="img/carat.png" />
      SwiftInstagram  Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="API.html">API</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/Instagram.html">Instagram</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Authentication.html">Authentication</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Enums/InstagramScope.html">InstagramScope</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Models.html">Models</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramUser.html">InstagramUser</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramUser/Counts.html">– Counts</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramRelationship.html">InstagramRelationship</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia.html">InstagramMedia</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia/Count.html">– Count</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia/Resolution.html">– Resolution</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia/Images.html">– Images</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia/Videos.html">– Videos</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia/UserInPhoto.html">– UserInPhoto</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramMedia/CarouselMedia.html">– CarouselMedia</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramComment.html">InstagramComment</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramTag.html">InstagramTag</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/InstagramLocation.html">InstagramLocation</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Errors.html">Errors</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Enums/InstagramError.html">InstagramError</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Other Structs.html">Other Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Other Structs.html#/s:14SwiftInstagram0B13EmptyResponseV">InstagramEmptyResponse</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content">
            
            <p align="center">
    <a href="https://andergoig.github.io/SwiftInstagram">
        <img src="https://rawgit.com/AnderGoig/SwiftInstagram/master/.assets/SwiftInstagram-Logo.png" alt="SwiftInstagram Logo" width="800" height="248">
    </a>
</p>

<p align="center">
    <a href="https://cocoapods.org/pods/SwiftInstagram">
        <img src="https://img.shields.io/cocoapods/p/SwiftInstagram.svg"
             alt="Platforms">
    </a>
    <a href="https://developer.apple.com/swift">
        <img src="https://img.shields.io/badge/Swift-4.0-orange.svg?style=flat"
             alt="Swift 4.0">
    </a>
    <a href="https://travis-ci.org/AnderGoig/SwiftInstagram/branches">
        <img src="https://img.shields.io/travis/AnderGoig/SwiftInstagram/master.svg"
             alt="Travis">
    </a>
    <a href="https://codebeat.co/projects/github-com-andergoig-swiftinstagram-master">
        <img src="https://codebeat.co/badges/e5274943-8feb-4e51-a937-43552205f62e"
             alt="Codebeat">
    </a>
    <a href="https://andergoig.github.io/SwiftInstagram">
        <img src="https://rawgit.com/AnderGoig/SwiftInstagram/master/docs/badge.svg"
             alt="Documentation">
    </a>
    <a href="https://raw.githubusercontent.com/AnderGoig/SwiftInstagram/master/LICENSE">
        <img src="https://img.shields.io/cocoapods/l/SwiftInstagram.svg"
             alt="License">
    </a>
</p>

<p align="center">
    <a href="https://cocoapods.org/pods/SwiftInstagram">
        <img src="https://img.shields.io/cocoapods/v/SwiftInstagram.svg"
             alt="CocoaPods compatible">
    </a>
    <a href="https://github.com/Carthage/Carthage">
        <img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat"
             alt="Carthage compatible">
    </a>
    <a href="https://github.com/apple/swift-package-manager">
        <img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg"
             alt="Swift Package Manager">
    </a>
</p>

<hr>

<p><strong>SwiftInstagram</strong> is a <strong>wrapper</strong> for the <strong>Instagram API</strong> written in <strong>Swift</strong>. It allows you to authenticate users and request data from Instagram effortlessly.</p>
<h2 id='features' class='heading'>Features</h2>

<ul>
<li>[x] Effortless and straightforward use.</li>
<li>[x] Up-to-date with the latest <a href="https://www.instagram.com/developer/">Instagram API</a> features.</li>
<li>[x] Secure access token storing, thanks to <a href="https://github.com/evgenyneu/keychain-swift">keychain-swift</a>.</li>
<li>[x] Client-Side authentication.</li>
<li>[x] 100% documented code.</li>
<li>[x] Use of Swift 4 Decodable.</li>
<li>[x] Up-to-date with the latest Apple technologies (Swift 4, Xcode 9, etc).</li>
</ul>
<h3 id='a-href-https-github-com-andergoig-swiftinstagram-projects-1-upcoming-features-a' class='heading'><a href="https://github.com/AnderGoig/SwiftInstagram/projects/1">Upcoming features</a></h3>
<h2 id='requirements' class='heading'>Requirements</h2>

<ul>
<li>iOS 9.0+</li>
<li>Xcode 9.0+</li>
</ul>
<h2 id='usage' class='heading'>Usage</h2>

<p>I&rsquo;ve prepared a <a href="https://github.com/AnderGoig/SwiftInstagram/wiki">wiki page</a> where you can find tons of useful things.</p>

<ul>
<li><a href="https://github.com/AnderGoig/SwiftInstagram/wiki/Installation-Guide">Installation Guide</a> - Follow it to integrate SwiftInstagram into your project.</li>
<li><a href="https://github.com/AnderGoig/SwiftInstagram/wiki/Authentication">Authentication</a> - To learn how to authenticate your Instagram users.</li>
<li><a href="https://github.com/AnderGoig/SwiftInstagram/wiki/Data-Retrieval">Data Retrieval</a> - To start requesting some data from Instagram.</li>
<li><a href="https://andergoig.github.io/SwiftInstagram/Classes/Instagram.html">API Reference</a> - For a more detailed code reference.</li>
</ul>
<h2 id='contributing' class='heading'>Contributing</h2>

<p>If you have feature requests or bug reports, feel free to help out by sending pull requests or by <a href="https://github.com/AnderGoig/SwiftInstagram/issues/new">creating new issues</a>. Please take a moment to
review the <a href=".github/CONTRIBUTING.md">CONTRIBUTING</a> guidelines.</p>
<h2 id='credits' class='heading'>Credits</h2>

<p>SwiftInstagram is brought to you by <a href="https://github.com/AnderGoig">Ander Goig</a> and <a href="https://github.com/AnderGoig/SwiftInstagram/contributors">contributors to the project</a>. If you&rsquo;re using SwiftInstagram in your project, attribution would be very appreciated.</p>
<h4 id='companion-libraries' class='heading'>Companion libraries</h4>

<p>SwiftInstagram uses <a href="https://github.com/evgenyneu/keychain-swift">keychain-swift</a> by <a href="https://github.com/evgenyneu">@evgenyneu</a> to safely store the access token retrieved by the authentication process.</p>
<h2 id='license' class='heading'>License</h2>

<p>SwiftInstagram is released under the MIT license. See <a href="LICENSE">LICENSE</a> for details.</p>
<h2 id='author' class='heading'>Author</h2>

<p>Ander Goig, <a href="mailto:goig.ander@gmail.com">goig.ander@gmail.com</a></p>

<p><a href="https://github.com/AnderGoig/SwiftInstagram">https://github.com/AnderGoig/SwiftInstagram</a></p>

          </div>
        </section>


      </article>
    </div>
    <section class="footer">
      <p>&copy; 2018 <a class="link" href="https://github.com/AnderGoig" target="_blank" rel="external">Ander Goig</a>. All rights reserved. (Last updated: 2018-10-14)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
